NAME¶

initdb - create a new PostgreSQL database cluster

SYNOPSIS¶

initdb [option...] [--pgdata | -D] directory

DESCRIPTION¶

initdb creates a new PostgreSQL database cluster.

Creating a database cluster consists of creating the directories in which the cluster data will live, generating the shared catalog tables (tables that belong to the whole cluster rather than to any particular database), and creating the postgres, template1, and template0 databases. The postgres database is a default database meant for use by users, utilities and third party applications. template1 and template0 are meant as source databases to be copied by later CREATE DATABASE commands. template0 should never be modified, but you can add objects to template1, which by default will be copied into databases created later. See Section 23.3 for more details.

Although initdb will attempt to create the specified data directory, it might not have permission if the parent directory of the desired data directory is root-owned. To initialize in such a setup, create an empty data directory as root, then use chown to assign ownership of that directory to the database user account, then su to become the database user to run initdb.

initdb must be run as the user that will own the server process, because the server needs to have access to the files and directories that initdb creates. Since the server cannot be run as root, you must not run initdb as root either. (It will in fact refuse to do so.)

For security reasons the new cluster created by initdb will only be accessible by the cluster owner by default. The --allow-group-access option allows any user in the same group as the cluster owner to read files in the cluster. This is useful for performing backups as a non-privileged user.

initdb initializes the database cluster's default locale and character set encoding. These can also be set separately for each database when it is created. initdb determines those settings for the template databases, which will serve as the default for all other databases.

By default, initdb uses the locale provider libc (see Section 24.1.4). The libc locale provider takes the locale settings from the environment, and determines the encoding from the locale settings.

To choose a different locale for the cluster, use the option --locale. There are also individual options --lc-* and --icu-locale (see below) to set values for the individual locale categories. Note that inconsistent settings for different locale categories can give nonsensical results, so this should be used with care.

Alternatively, initdb can use the ICU library to provide locale services by specifying --locale-provider=icu. The server must be built with ICU support. To choose the specific ICU locale ID to apply, use the option --icu-locale. Note that for implementation reasons and to support legacy code, initdb will still select and initialize libc locale settings when the ICU locale provider is used.

When initdb runs, it will print out the locale settings it has chosen. If you have complex requirements or specified multiple options, it is advisable to check that the result matches what was intended.

More details about locale settings can be found in Section 24.1.

To alter the default encoding, use the --encoding. More details can be found in Section 24.3.

OPTIONS¶

-A authmethod
--auth=authmethod

--auth-host=authmethod

--auth-local=authmethod

-D directory
--pgdata=directory

-E encoding
--encoding=encoding

-g
--allow-group-access

--icu-locale=locale

--icu-rules=rules

-k
--data-checksums

--locale=locale

--lc-collate=locale
--lc-ctype=locale
--lc-messages=locale
--lc-monetary=locale
--lc-numeric=locale
--lc-time=locale

--no-locale

--locale-provider={libc|icu}

-N
--no-sync

--no-instructions

--pwfile=filename

-S
--sync-only

-T config
--text-search-config=config

-U username
--username=username

-W
--pwprompt

-X directory
--waldir=directory

--wal-segsize=size

Other, less commonly used, options are also available:

-c name=value
--set name=value

-d
--debug

--discard-caches

-L directory

-n
--no-clean

Other options:

-V
--version

-?
--help

ENVIRONMENT¶

PGDATA

PG_COLOR

TZ

This utility, like most other PostgreSQL utilities, also uses the environment variables supported by libpq (see Section 34.15).

NOTES¶

initdb can also be invoked via pg_ctl initdb.

SEE ALSO¶

pg_ctl(1), postgres(1), Section 21.1